<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>unit_test::suite</title>
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
<link rel="prev" href="boost__beast__websocket__stream_base/none.html" title="websocket::stream_base::none">
<link rel="next" href="boost__beast__unit_test__suite/fail.html" title="unit_test::suite::fail">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__websocket__stream_base/none.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__unit_test__suite/fail.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="beast.ref.boost__beast__unit_test__suite"></a><a class="link" href="boost__beast__unit_test__suite.html" title="unit_test::suite">unit_test::suite</a>
</h4></div></div></div>
<p>
        A testsuite class.
      </p>
<h5>
<a name="beast.ref.boost__beast__unit_test__suite.h0"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__unit_test__suite.synopsis"></a></span><a class="link" href="boost__beast__unit_test__suite.html#beast.ref.boost__beast__unit_test__suite.synopsis">Synopsis</a>
      </h5>
<p>
        Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/_experimental/unit_test/suite.hpp" target="_top">boost/beast/_experimental/unit_test/suite.hpp</a>&gt;</code>
      </p>
<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">suite</span>
</pre>
<h5>
<a name="beast.ref.boost__beast__unit_test__suite.h1"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__unit_test__suite.types"></a></span><a class="link" href="boost__beast__unit_test__suite.html#beast.ref.boost__beast__unit_test__suite.types">Types</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody><tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite__scoped_testcase.html" title="unit_test::suite::scoped_testcase">scoped_testcase</a></strong></span>
                </p>
              </td>
<td>
              </td>
</tr></tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__unit_test__suite.h2"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__unit_test__suite.static_members"></a></span><a class="link" href="boost__beast__unit_test__suite.html#beast.ref.boost__beast__unit_test__suite.static_members">Static
        Members</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/expect.html" title="unit_test::suite::expect">expect</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Evaluate a test condition.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/fail.html" title="unit_test::suite::fail">fail</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Record a failure.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/this_suite.html" title="unit_test::suite::this_suite">this_suite</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Returns the "current" running suite.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__unit_test__suite.h3"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__unit_test__suite.member_functions"></a></span><a class="link" href="boost__beast__unit_test__suite.html#beast.ref.boost__beast__unit_test__suite.member_functions">Member
        Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/arg.html" title="unit_test::suite::arg">arg</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Return the argument associated with the runner.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/except.html" title="unit_test::suite::except">except</a></strong></span>
                </p>
              </td>
<td>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/expect.html" title="unit_test::suite::expect">expect</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Evaluate a test condition.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/fail.html" title="unit_test::suite::fail">fail</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Record a failure.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/operator_lp__rp_.html" title="unit_test::suite::operator()">operator()</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Invokes the test using the specified runner.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/operator_eq_.html" title="unit_test::suite::operator=">operator=</a></strong></span>
                </p>
              </td>
<td>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/pass.html" title="unit_test::suite::pass">pass</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Record a successful test condition.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/suite.html" title="unit_test::suite::suite">suite</a> <span class="silver">[constructor]</span></strong></span>
                </p>
              </td>
<td>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/unexcept.html" title="unit_test::suite::unexcept">unexcept</a></strong></span>
                </p>
              </td>
<td>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/unexpected.html" title="unit_test::suite::unexpected">unexpected</a></strong></span>
                </p>
              </td>
<td>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/_suite.html" title="unit_test::suite::~suite">~suite</a> <span class="silver">[destructor]</span></strong></span>
                </p>
              </td>
<td>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__unit_test__suite.h4"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__unit_test__suite.data_members"></a></span><a class="link" href="boost__beast__unit_test__suite.html#beast.ref.boost__beast__unit_test__suite.data_members">Data Members</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/expect.html" title="unit_test::suite::expect">expect</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Evaluate a test condition.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/fail.html" title="unit_test::suite::fail">fail</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Record a failure.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/log.html" title="unit_test::suite::log">log</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Logging output stream.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <span class="bold"><strong><a class="link" href="boost__beast__unit_test__suite/testcase.html" title="unit_test::suite::testcase">testcase</a></strong></span>
                </p>
              </td>
<td>
                <p>
                  Memberspace for declaring test cases.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="beast.ref.boost__beast__unit_test__suite.h5"></a>
        <span class="phrase"><a name="beast.ref.boost__beast__unit_test__suite.description"></a></span><a class="link" href="boost__beast__unit_test__suite.html#beast.ref.boost__beast__unit_test__suite.description">Description</a>
      </h5>
<p>
        Derived classes execute a series of testcases, where each testcase is a series
        of pass/fail tests. To provide a unit test using this class, derive from
        it and use the BOOST_BEAST_DEFINE_UNIT_TEST macro in a translation unit.
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="boost__beast__websocket__stream_base/none.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__unit_test__suite/fail.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
